/*
 * Copyright (c) 2001 Sun Microsystems, Inc.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *       Sun Microsystems, Inc. for Project JXTA."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact Project JXTA at http://www.jxta.org.
 *
 * 5. Products derived from this software may not be called "JXTA",
 *    nor may "JXTA" appear in their name, without prior written
 *    permission of Sun.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Project JXTA.  For more
 * information on Project JXTA, please see
 * <http://www.jxta.org/>.
 *
 * This license is based on the BSD license adopted by the Apache Foundation.
 *
 * $Id: ContentAdvertisementImpl.java,v 1.18 2006/02/07 20:43:49 bondolo Exp $
 *
 */

package net.jxta.share;

import net.jxta.document.Advertisement;
import net.jxta.document.AdvertisementFactory;
import net.jxta.document.Document;
import net.jxta.document.StructuredDocumentFactory;
import net.jxta.document.StructuredTextDocument;
import net.jxta.document.StructuredDocument;
import net.jxta.document.TextElement;
import net.jxta.document.Element;
import net.jxta.document.MimeMediaType;

import net.jxta.share.metadata.ContentMetadata;
import net.jxta.share.metadata.ContentMetadataFactory;

import java.io.InputStream;
import java.io.IOException;
import java.util.Enumeration;
import java.util.Vector;

import org.apache.log4j.Logger;
import org.apache.log4j.Level;

/*
 * ContentAdvertisement implementation for content manager.
 */
public class ContentAdvertisementImpl extends ContentAdvertisement {

    private final static transient Logger LOG = Logger.getLogger(ContentAdvertisementImpl.class.getName());

    private String name; // content name (required)
    private ContentId cid; // content id (required)
    private long length = -1; // content length (optional)
    private String type; // content type (optional)
    private String description; // content description (optional)
    private ContentMetadata[] metadata;// metadata of content (optional)
    private String address; // address of content (optional)
    private static boolean isRegistered = false;

    private static final String [] fields = {EN_NAME, EN_CID, EN_TYPE};

    public static class Instantiator implements AdvertisementFactory.Instantiator {

        /**
         * Returns the identifying type of this Advertisement.
         *
         * @return String the type of advertisement
         *
         * @since JXTA 1.0
         **/
        public String getAdvertisementType( ) {
            return ContentAdvertisementImpl.getAdvertisementType();
        }

        /**
         * Constructs an instance of <CODE>Advertisement</CODE> matching the type
         * specified by the <CODE>advertisementType</CODE> parameter.
         *
         * @param advertisementType Specifies the mime media type to be associated with the
         * <CODE>StructuredDocument</CODE> to be created.
         * @return The instance of <CODE>Advertisement</CODE> or null if it
         * could not be created.
         *
         * @exception InvocationTargetException error invoking target constructor
         *
         * @since JXTA 1.0
         **/
        public Advertisement newInstance( ) {
            return new ContentAdvertisementImpl();
        }

        /**
         * Constructs an instance of <CODE>Advertisement</CODE> matching the type
         * specified by the <CODE>advertisementType</CODE> parameter.
         *
         * @param root Specifies a portion of a StructuredDocument which will be
         * converted into an Advertisement.
         * @return The instance of <CODE>Advertisement</CODE> or null if it
         * could not be created.
         *
         * @exception InvocationTargetException error invoking target constructor
         *
         * @since JXTA 1.0
         **/
        public Advertisement newInstance( net.jxta.document.Element root ) {
            return new ContentAdvertisementImpl( (TextElement) root );
        }
    };

    // Empty Constructor
    ContentAdvertisementImpl() {
        registerAdvertisement();
    }


    /*
     * Creates a new ContentAdvertisement for the specified content name,
     * id, length, type, and description
     * @param name the content name
     * @param cid the content id
     * @param length the content length, or -1 if not specified
     * @param type the content mime type, or null if not specified
     * @param description the content description, or null if not specified
     * @exception NullPointerException if name or cid is null
     */
    ContentAdvertisementImpl(String name, ContentId cid, long length,
                             String type, String description) {
        registerAdvertisement();

        if (name == null) {
            throw new NullPointerException("name");
        }
        if (cid == null) {
            throw new NullPointerException("cid");
        }
        this.name = name;
        this.cid = cid;
        this.type = type;
        this.length = length;
        this.description = description;
        this.metadata = null;
        this.address = null;
    }

    /*
     * Creates a new ContentAdvertisement for the specified content name,
     * id, length, type, and description
     * @param name the content name
     * @param cid the content id
     * @param length the content length, or -1 if not specified
     * @param type the content mime type, or null if not specified
     * @param description the content description, or null if not specified
     * @param address the address of the peer that contains the content, or
     * null if not specified
     * @exception NullPointerException if name or cid is null
     */
    ContentAdvertisementImpl(String name, ContentId cid, long length,
                             String type, String description, String address) {
        registerAdvertisement();

        if (name == null) {
            throw new NullPointerException("name");
        }
        if (cid == null) {
            throw new NullPointerException("cid");
        }
        this.name = name;
        this.cid = cid;
        this.type = type;
        this.length = length;
        this.description = description;
        this.metadata = null;
        this.address = address;
    }

    /*
     * Creates a new ContentAdvertisement for the specified content name,
     * id, length, type, and description
     * @param name the content name
     * @param cid the content id
     * @param length the content length, or -1 if not specified
     * @param type the content mime type, or null if not specified
     * @param metadata the an array of different metadata descriptions of this
     * content or null if not specified.
     * @param address the address of the peer that contains the content, or
     * null if not specified
     * @exception NullPointerException if name or cid is null or metadata
     * contains a null element.
     */
    ContentAdvertisementImpl(String name, ContentId cid, long length,
                             String type, ContentMetadata[] metadata,
                             String address) {
        registerAdvertisement();

        if (name == null) {
            throw new NullPointerException("name");
        }
        if (cid == null) {
            throw new NullPointerException("cid");
        }
        this.name = name;
        this.cid = cid;
        this.type = type;
        this.length = length;

        //in future versions of this class, description will be completely
        // replaced by metadata, but for now just make it null.
        this.description = null;
        this.metadata = metadata;

        //rat out null metadata elements right away, rather than waiting for
        //appendElements() to be called
        if(metadata != null) {
            for(int a = 0; a < metadata.length; a++) {
                if(metadata[a] == null)
                    throw new NullPointerException("null metadata element");
            }
        }

        this.address = address;
    }

    /**
     * Creates a new ContentAdvertisement from the specified InputStream.
     * @param is the InputStream containing the advertisement
     * @exception IllegalArgumentException if the advertisement was invalid
     * @exception IOException if there was an I/O error
     */
    public ContentAdvertisementImpl(InputStream is) throws IOException {

        registerAdvertisement();

        StructuredTextDocument doc = (StructuredTextDocument)
                                     StructuredDocumentFactory.newStructuredDocument(
                                         new MimeMediaType("text", "xml"), is);
        init(doc);
    }

    /**
     * Creates a new ContentAdvertisement from the specified TextElement.
     * @exception IllegalArgumentException if the TextElement was missing data
     * or contained invalid data
     * @exception NullPointerException if te is null
     * @see ContentMetadataFactory
     */
    public ContentAdvertisementImpl(TextElement te) {
        registerAdvertisement();
        init(te);
    }

    // reads advertisement from specified TextElement
    private void init(TextElement root) {
        Vector metadataElems = new Vector();
        if (!root.getName().equals(getAdvertisementType())) {
            throw new IllegalArgumentException(
                "Not a ContentAdvertisement element: " + root.getName());
        }
        Enumeration e = root.getChildren();
        while (e.hasMoreElements()) {
            TextElement te = (TextElement)e.nextElement();
            String s = te.getName();
            String t = te.getTextValue();
            if ((t != null)||(te.getChildren() !=null)) {
                if (s.equals(EN_NAME)) {
                    name = t;
                } else
                    if (s.equals(EN_CID)) {
                        try {
                            cid = new ContentIdImpl(t);
                        } catch (IllegalArgumentException ex) {
                            throw new IllegalArgumentException(
                                "Invalid content id: " + t);
                        }
                    } else
                        if (s.equals(EN_LENGTH)) {
                            try {
                                length = Long.parseLong(t);
                            } catch (NumberFormatException ex) {
                                throw new IllegalArgumentException(
                                    "Invalid content length: " + t);
                            }
                        } else
                            if (s.equals(EN_TYPE)) {
                                type = t;
                            } else
                                if (s.equals(EN_DESCRIPTION)) {
                                    description = t;
                                } else
                                    if (s.equals(EN_METADATA)) {
                                        metadataElems.addElement(ContentMetadataFactory
                                                                 .newInstance(te));
                                    } else
                                        if (s.equals(EN_ADDRESS)) {
                                            address = t;
                                        }
            } else
                if (s.equals(EN_METADATA)) {
                    //a metadata element may have a null value if all of its
                    //information is stored in sub-elements
                    metadataElems.addElement(ContentMetadataFactory
                                             .newInstance(te));
                }
        }
        if (name == null) {
            throw new IllegalArgumentException(
                "Missing required 'name' element");
        }
        if (cid == null) {
            throw new IllegalArgumentException(
                "Missing required 'cid' element");
        }
        if(metadataElems.size() != 0) {
            metadata = new ContentMetadata[metadataElems.size()];
            metadataElems.toArray(metadata);
        }
    }

    /**
     * Returns the advertisement type.
     */
    public static String getAdvertisementType() {
        return "jxta:ContentAdvertisement";
    }

    /**
     * Returns the name of the content.
     */
    public String getName() {
        return name;
    }

    /**
     * Returns the content id.
     */
    public ContentId getContentId() {
        return cid;
    }

    /**
     * Returns the length of the content, or -1 if unknown
     */
    public long getLength() {
        return length;
    }

    /**
     * Returns the mime type of the content, or null if unknown
     */
    public String getType() {
        return type;
    }

    /**
     * Returns the description of the content or null if none.
     */
    public String getDescription() {
        return description;
    }

    /**
     * Returns the metadata describing this content, or null if not specified.
     */
    public ContentMetadata[] getMetadata() {
        return metadata;
    }

    /**
     * Returns the peer id or null if none.
     */
    public String getAddress() {
        return address;
    }

    /**
     * Sets the address of the peer that holds the content.
     */
    public void setAddress(String address) {
        this.address = address;
    }

    /**
     * Returns the document representation of this advertisement.
     */
    public Document getDocument(MimeMediaType mtype) {
        StructuredDocument doc = (StructuredDocument)
                                 StructuredDocumentFactory.newStructuredDocument(
                                     mtype, getAdvertisementType());
        appendElements(doc, doc);
        return doc;
    }

    /**
     * Appends this content advertisement to the specified structured
     * document element.
     */
    public void appendDocument(StructuredDocument doc, Element el) {
        Element e = doc.createElement(getAdvertisementType());
        el.appendChild(e);
        appendElements(doc, e);
    }

    // append elements to specified document element
    private void appendElements(StructuredDocument doc, Element e) {
        e.appendChild(doc.createElement(EN_NAME, name));
        e.appendChild(doc.createElement(EN_CID, cid.toString()));
        if (length != -1) {
            e.appendChild(doc.createElement(EN_LENGTH, Long.toString(length)));
        }
        if (type != null) {
            e.appendChild(doc.createElement(EN_TYPE, type));
        }
        if (description != null) {
            e.appendChild(doc.createElement(EN_DESCRIPTION, description));
        }
        if (metadata != null) {
            for(int a = 0; a < metadata.length; a++) {
                //insert metadata element into doc
                metadata[a].appendDocument(doc, doc);
            }
        }
        if (address != null) {
            e.appendChild(doc.createElement(EN_ADDRESS, address));
        }
    }

    public boolean equals(Object adv) {
        if (LOG.isEnabledFor(Level.DEBUG))
            LOG.debug("ContentAdvertismentImpl.equals("+adv.toString()+") "+toString());
        if (adv instanceof ContentAdvertisementImpl) {
            return toString().equals(((ContentAdvertisementImpl)adv).toString());
        }

        return false;
    }

    /**
     * Returns a string representation of this advertisement.
     */
    public String toString() {
        StringBuffer sb = new StringBuffer();
        sb.append("{name=");
        sb.append(name);
        sb.append(";cid=");
        sb.append(cid.toString());
        if (length != -1) {
            sb.append(";length=");
            sb.append(length);
        }
        if (type != null) {
            sb.append(";type=");
            sb.append(type);
        }
        if (description != null) {
            sb.append(";description=");
            sb.append(description);
        }
        if (metadata != null) {
            sb.append(";metadata=(");
            for(int a = 0; a < metadata.length; a++)
                sb.append(metadata[a] + "|");
            sb.setCharAt(sb.length() - 1, ')');
        }
        if (address != null) {
            sb.append(";address=");
            sb.append(address);
        }
        sb.append('}');
        return sb.toString();
    }

    public static void registerAdvertisement () {

        if (!isRegistered) {
            // make sure that the AdvertisementFactory knows about ContentAdvertisement.
            AdvertisementFactory.Instantiator instantiator = new Instantiator();
            AdvertisementFactory.registerAdvertisementInstance (getAdvertisementType(),
                    instantiator);
            isRegistered = true;
        }
    }

    public String [] getIndexFields() {
        return fields;
    }
}
